Reinstate supplemental remarks (System.Text, System.Threading)#12706
Open
gewarren wants to merge 4 commits into
Open
Reinstate supplemental remarks (System.Text, System.Threading)#12706gewarren wants to merge 4 commits into
gewarren wants to merge 4 commits into
Conversation
github-actions
Bot
added
the
area-Meta
Contributor
There was a problem hiding this comment.
Pull request overview
This PR moves previously “supplemental API remarks” content back into this repo by replacing external “Supplemental API remarks” links with inlined <remarks><format type="text/markdown"><![CDATA[ ... ]]></format></remarks> blocks for several System.Text*, System.Threading*, and System.Threading.Tasks* APIs. It also adds/updates snippet projects (notably Visual Basic, plus some C#) to back the newly inlined docs.
Changes:
- Replaced “Supplemental API remarks” link-outs with reinstated, inlined markdown remarks for several threading, tasks, and text APIs.
- Added many new snippet files and SDK-style snippet projects (including a new VB WPF sample) referenced by the reinstated remarks.
- Updated/normalized some existing snippet project targets (for example,
System.Text.Encodingsnippet project tonet10.0).
Reviewed changes
Copilot reviewed 71 out of 71 changed files in this pull request and generated 21 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Threading/Thread.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Threading/ReaderWriterLockSlim.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Threading/Monitor.xml | Replaces external supplemental-remarks link with inlined markdown remarks; adds/expands per-member remarks for Monitor.Wait. |
| xml/System.Threading.Tasks/TaskScheduler.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Threading.Tasks/Task.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Text/StringBuilder.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Text/Rune.xml | Replaces external supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Text/Encoding.xml | Replaces external supplemental-remarks link with inlined markdown remarks and updates Encoding.Default remarks. |
| xml/System.Text.RegularExpressions/Regex.xml | Adjusts a Regex.Match overload remarks block (currently to a placeholder). |
| snippets/visualbasic/System.Threading/Thread/Overview/ThreadStart2.vb | Adds VB snippet backing Thread “ParameterizedThreadStart” example. |
| snippets/visualbasic/System.Threading/Thread/Overview/ThreadStart1.vb | Adds VB snippet backing ThreadStart example. |
| snippets/visualbasic/System.Threading/Thread/Overview/source.vb | Adds VB snippet backing basic Thread example. |
| snippets/visualbasic/System.Threading/Thread/Overview/Project.vbproj | Adds VB snippet project for Thread overview snippets. |
| snippets/visualbasic/System.Threading/Thread/Overview/Instance1.vb | Adds VB snippet backing Thread.CurrentThread example. |
| snippets/visualbasic/System.Threading/Thread/Overview/BackgroundEx1.vb | Adds VB snippet backing foreground/background example. |
| snippets/visualbasic/System.Threading/ReaderWriterLockSlim/Overview/Project.vbproj | Adds VB snippet project for ReaderWriterLockSlim overview snippets. |
| snippets/visualbasic/System.Threading/ReaderWriterLockSlim/Overview/classexample1.vb | Adds VB snippet backing ReaderWriterLockSlim synchronized cache example. |
| snippets/visualbasic/System.Threading/Monitor/Overview/source.vb | Adds VB snippet backing Monitor SyncLock example. |
| snippets/visualbasic/System.Threading/Monitor/Overview/Project.vbproj | Adds VB snippet project for Monitor overview snippets. |
| snippets/visualbasic/System.Threading/Monitor/Overview/Pattern2.vb | Adds VB snippet backing Monitor.Enter/Exit pattern examples. |
| snippets/visualbasic/System.Threading/Monitor/Overview/example1.vb | Adds VB snippet backing Monitor with tasks/random example. |
| snippets/visualbasic/System.Threading/Monitor/Overview/badlock1.vb | Adds VB snippet showing incorrect locking on boxed value type. |
| snippets/visualbasic/System.Threading/Monitor/Overview/badbox1.vb | Adds VB snippet showing boxing workaround example. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/WpfApp.vbproj | Adds VB WPF snippet project used by TaskScheduler.FromCurrentSynchronizationContext example. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/MainWindow.xaml.vb | Adds VB WPF code-behind snippet for the TaskScheduler UI-thread example. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/MainWindow.xaml | Adds VB WPF XAML for the TaskScheduler UI-thread example. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/AssemblyInfo.vb | Adds WPF ThemeInfo assembly attribute file. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/Application.xaml.vb | Adds WPF application code-behind file. |
| snippets/visualbasic/System.Threading.Tasks/TaskScheduler/Overview/Application.xaml | Adds WPF application XAML. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/WaitAny1.vb | Adds VB snippet backing Task.WaitAny example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/WaitAll2.vb | Adds VB snippet backing Task.WaitAll exception behavior example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/WaitAll1.vb | Adds VB snippet backing Task.WaitAll basic example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/Wait2.vb | Adds VB snippet backing Task.Wait(timeout) example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/Wait1.vb | Adds VB snippet backing Task.Wait() example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/startnew1.vb | Adds VB snippet backing TaskFactory.StartNew example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/startnew.vb | Adds VB snippet backing mixed task instantiation patterns example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/run1.vb | Adds VB snippet backing Task.Run example. |
| snippets/visualbasic/System.Threading.Tasks/Task/Overview/Project.vbproj | Adds VB snippet project for Task overview snippets. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/replace1.vb | Adds VB snippet backing StringBuilder.Replace example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/Project.vbproj | Adds VB snippet project for StringBuilder overview snippets. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/pattern4.vb | Adds VB snippet backing regex-based transformation example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/pattern3.vb | Adds VB snippet backing character-index transformation example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/pattern2.vb | Adds VB snippet backing match-based transformation example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/pattern1.vb | Adds VB snippet backing “search before append” example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/instantiate1.vb | Adds VB snippet backing constructor overloads example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/expand1.vb | Adds VB snippet backing append/format/insert example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/delete1.vb | Adds VB snippet backing remove/clear example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/default1.vb | Adds VB snippet backing capacity growth example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/chars1.vb | Adds VB snippet backing indexer/chars iteration example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/call2.vb | Adds VB snippet backing method-chaining example. |
| snippets/visualbasic/System.Text/StringBuilder/Overview/call1.vb | Adds VB snippet backing stepwise calls example. |
| snippets/visualbasic/System.Text/Encoding/Overview/Project.vbproj | Adds VB snippet project for Encoding overview snippets. |
| snippets/visualbasic/System.Text/Encoding/Overview/getencoding1.vb | Adds VB snippet backing Encoding.GetEncoding example. |
| snippets/visualbasic/System.Text/Encoding/Overview/convert.vb | Adjusts VB snippet entrypoint/class naming for encoding convert example. |
| snippets/csharp/System.Text/StringBuilder/Overview/replace1.cs | Adds C# snippet backing StringBuilder.Replace example. |
| snippets/csharp/System.Text/StringBuilder/Overview/Project.csproj | Adds C# snippet project for StringBuilder overview (including unsafe allowance). |
| snippets/csharp/System.Text/StringBuilder/Overview/pattern4.cs | Adds C# snippet backing regex-based transformation example. |
| snippets/csharp/System.Text/StringBuilder/Overview/pattern3.cs | Adds C# snippet backing index-based transformation example. |
| snippets/csharp/System.Text/StringBuilder/Overview/pattern2.cs | Adds C# snippet backing match-based transformation example. |
| snippets/csharp/System.Text/StringBuilder/Overview/pattern1.cs | Adds C# snippet backing “search before append” example. |
| snippets/csharp/System.Text/StringBuilder/Overview/instantiate1.cs | Adds C# snippet backing constructor overloads example. |
| snippets/csharp/System.Text/StringBuilder/Overview/immutability2.cs | Adds C# unsafe snippet demonstrating string immutability. |
| snippets/csharp/System.Text/StringBuilder/Overview/expand1.cs | Adds C# snippet backing append/format/insert example. |
| snippets/csharp/System.Text/StringBuilder/Overview/delete1.cs | Adds C# snippet backing remove/clear example. |
| snippets/csharp/System.Text/StringBuilder/Overview/default1.cs | Adds C# snippet backing capacity growth example. |
| snippets/csharp/System.Text/StringBuilder/Overview/chars1.cs | Adds C# snippet backing indexer/chars iteration example. |
| snippets/csharp/System.Text/StringBuilder/Overview/call2.cs | Adds C# snippet backing method-chaining example. |
| snippets/csharp/System.Text/StringBuilder/Overview/call1.cs | Adds C# snippet backing stepwise calls example. |
| snippets/csharp/System.Text/Encoding/Overview/Project.csproj | Updates C# encoding snippet project to net10.0. |
| snippets/csharp/System.Text/Encoding/Overview/getencoding1.cs | Adds C# snippet backing Encoding.GetEncoding example. |
| snippets/csharp/System.Text/Encoding/Overview/convert.cs | Adjusts C# snippet entrypoint/class naming for encoding convert example. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributes to #12613.
Also removes .NET Framework remarks.